home *** CD-ROM | disk | FTP | other *** search
/ IRIX Base Documentation 1998 November / IRIX 6.5.2 Base Documentation November 1998.img / usr / share / catman / u_man / cat1 / newhelp.z / newhelp
Text File  |  1998-10-20  |  5KB  |  133 lines
  1.  
  2.  
  3.  
  4. NNNNEEEEWWWWHHHHEEEELLLLPPPP((((1111))))                                                          NNNNEEEEWWWWHHHHEEEELLLLPPPP((((1111))))
  5.  
  6.  
  7.  
  8. NNNNAAAAMMMMEEEE
  9.      nnnneeeewwwwhhhheeeellllpppp - generate a performance metrics help database
  10.  
  11. SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS
  12.      ////uuuussssrrrr////ppppccccpppp////bbbbiiiinnnn////nnnneeeewwwwhhhheeeellllpppp [----VVVV] [----nnnn _p_m_n_s_f_i_l_e] [----oooo _o_u_t_p_u_t_f_i_l_e] [----vvvv _v_e_r_s_i_o_n]
  13.      [_f_i_l_e ...]
  14.  
  15. DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
  16.      nnnneeeewwwwhhhheeeellllpppp generates the Performance Co-Pilot help text files used by
  17.      Performance Metric Domain Agents (PMDAs).
  18.  
  19.      Normally nnnneeeewwwwhhhheeeellllpppp operates on the default Performance Metrics Namespace
  20.      (PMNS), however if the ----nnnn option is specified an alternative namespace is
  21.      loaded from the file _p_m_n_s_f_i_l_e.
  22.  
  23.      When there is only one input file, the base name of the new database is
  24.      derived from the name of the input _f_i_l_e, otherwise the ----oooo flag must be
  25.      given to explicitly name the database.  If no input files are supplied,
  26.      nnnneeeewwwwhhhheeeellllpppp reads from the standard input stream, in which case the ----oooo flag
  27.      must be given.
  28.  
  29.      If the output file name is determined to be ffffoooooooo, nnnneeeewwwwhhhheeeellllpppp will create
  30.      ffffoooooooo....ddddiiiirrrr and ffffoooooooo....ppppaaaagggg.
  31.  
  32.      There are currently two help text file formats - the format used can be
  33.      specified using the ----vvvv option.  Previous versions of PCP used nnnnddddbbbbmmmm(3B)
  34.      files to store the help text.  This format may be selected using _v_e_r_s_i_o_n
  35.      1111, but is not recommended unless the associated PMDA uses the older
  36.      protocols and is linked with _l_i_b_p_c_p__p_m_d_a._s_o._1.  This is the default
  37.      version so that pre-existing invocations of nnnneeeewwwwhhhheeeellllpppp will still work the
  38.      same way.
  39.  
  40.      The current PCP version uses a more compact storage scheme for the help
  41.      text files, and this may be selected using _v_e_r_s_i_o_n 2222.
  42.  
  43.      The ----VVVV flag causes verbose messages to be printed whilst nnnneeeewwwwhhhheeeellllpppp is
  44.      parsing its input.
  45.  
  46.      The first line of each entry in a help source file consists of an ``@''
  47.      character beginning the line followed by a space and then the performance
  48.      metric name and a one line description of the metric.  Following lines
  49.      (up to the next line beginning with ``@'' or end of file) may contain a
  50.      verbose help description.  E.g.
  51.  
  52.           #
  53.           # This is an example of newhelps input syntax
  54.           #
  55.           @ irix.kernel.all.cpu.idle CPU idle time
  56.           A cumulative count of the number of milliseconds
  57.           of CPU idle time, summed over all processors.
  58.  
  59.  
  60.  
  61.  
  62.  
  63.                                                                         PPPPaaaaggggeeee 1111
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70. NNNNEEEEWWWWHHHHEEEELLLLPPPP((((1111))))                                                          NNNNEEEEWWWWHHHHEEEELLLLPPPP((((1111))))
  71.  
  72.  
  73.  
  74.      Lines beginning with ``#'' are ignored, as are blank lines in the file
  75.      before the first ``@''.  The verbose help text is optional.
  76.  
  77.      As a special case, a ``metric'' name of the form _N_N_N._M_M (for numeric _N_N_N
  78.      and _M_M) is interpreted as an instance domain identification, and the text
  79.      describes the instance domain.
  80.  
  81. FFFFIIIILLLLEEEESSSS
  82.      ////vvvvaaaarrrr////ppppccccpppp////ppppmmmmnnnnssss////*         default PMNS specification files
  83.  
  84. SSSSEEEEEEEE AAAALLLLSSSSOOOO
  85.      cccchhhhkkkkhhhheeeellllpppp(1), ppppmmmmcccchhhhaaaarrrrtttt(1), PPPPMMMMAAAAPPPPIIII(3), ppppmmmmLLLLooooooookkkkuuuuppppIIIInnnnDDDDoooommmmTTTTeeeexxxxtttt(3) and
  86.      ppppmmmmLLLLooooooookkkkuuuuppppTTTTeeeexxxxtttt(3).
  87.  
  88. DDDDIIIIAAAAGGGGNNNNOOOOSSSSTTTTIIIICCCCSSSS
  89.  
  90.  
  91.  
  92.  
  93.  
  94.  
  95.  
  96.  
  97.  
  98.  
  99.  
  100.  
  101.  
  102.  
  103.  
  104.  
  105.  
  106.  
  107.  
  108.  
  109.  
  110.  
  111.  
  112.  
  113.  
  114.  
  115.  
  116.  
  117.  
  118.  
  119.  
  120.  
  121.  
  122.  
  123.  
  124.  
  125.  
  126.                                                                         PPPPaaaaggggeeee 2222
  127.  
  128.  
  129.  
  130.  
  131.  
  132.  
  133.